Fetch Authorizations

Fetch specific authorization

Use this endpoint to fetch information about an Automatic Pix authorization

Fetch all authorizations

This endpoint will fetch all the authorizations, be them sent or received

Request

GET 'https://apisandbox.delbank.com.br/baas/api/v1/pix/automatic/authorizations'

Headers

Name	Description
x-delbank-api-key	Required. API key

Query Parameters:

Name	Type	Description
Flow	number	Required. 0 for payer or 1 for receiver
BeneficiaryDocument	string	Optional. Beneficiary document (max 14 characters)
BeneficiaryAccount	string	Optional. Beneficiary account
PayerPersonType	number	Optional. 0 for Natural Person (CPF) or 1 for Legal Person (CNPJ)
PayerDocument	string	Optional. Payer document (CPF/CNPJ - max 14 characters)
PayerAgencyNumber	string	Optional. Payer agency number (max 4 characters)
PayerAccountNumber	string	Optional. Payer account number (max 20 characters)
AuthorizationResult	string	Optional. The result of the authorization
Status	string	Optional. The status of the authorization
RecurrenceUpdatedDateTimeFrom	date	Optional. Filter by updated date from (DateTime format)
RecurrenceUpdatedDateTimeTo	date	Optional. Filter by updated date to (DateTime format)
Page	number	Optional. The page number (Default: 1). Must be a positive number
PageSize	number	Optional. The amount of results returned per page (Default: 50, Max: 100)
RecurrenceStartDateFrom	date	Optional. Filter by recurrence start date from (DateOnly format)
RecurrenceStartDateTo	date	Optional. Filter by recurrence start date to (DateOnly format)
RecurrenceCreatedDateTimeFrom	date	Optional. Filter by recurrence creation date from (DateTime format)
RecurrenceCreatedDateTimeTo	date	Optional. Filter by recurrence creation date to (DateTime format)

Response

The status code 200 indicates success in the query.

Being succeeded, the return will have the following fields in Json format:

{
    "data": [
        {
            "id": "e45a2b8c-9c3f-412d-a78b-3e5f1d9a0c2b",
            "flow": "RECEIVER",
            "recurrenceId": "RR3822895720250530oouu9uhf473",
            "journey": 2,
            "frequencyType": "ANNUAL",
            "authorizationResult": "AUTHORIZED",
            "beneficiary": {
                "ispb": "38224857",
                "document": "03284584000162",
                "name": "corporateName",
                "agencyNumber": "0001",
                "accountType": "CURRENT",
                "accountNumber": "98765"
            },
            "payer": {
                "ispb": "38224857",
                "type": "LEGAL",
                "document": "03284584000162",
                "name": "corporateName",
                "agencyNumber": "1",
                "accountType": "PAYMENT",
                "accountNumber": "31275",
                "municipalityIbgeCode": 2800308
            },
            "debtor": {
                "type": "NATURAL",
                "document": "86829503086",
                "name": "Conta Teste 02"
            },
            "contractNumber": "1234567890ABC",
            "contractDescription": "Assinatura Anual",
            "recurrenceStartDate": "2025-07-02T00:00:00",
            "recurrenceEndDate": "2026-07-02T00:00:00",
            "recurrenceCreatedAt": "2025-07-08T15:32:35.532Z",
            "requestCreatedAt": "2025-07-08T15:32:35.838Z",
            "requestExpirationAt": "2025-07-08T16:00:00.000Z",
            "recurrenceAuthorizedAt": "2025-07-08T15:32:35.532Z",
            "lastInstructionAt": "2025-07-08T15:32:36.208Z",
            "amount": 100.00,
            "payerMaxAmount": 150.00,
            "minPayerMaxAmount": 100.00,
            "status": "ACTIVE",
            "reasonRejection": null,
            "beneficiaryReconciliationId": "REC-123",
            "cityIbgeCode": "2800308"
        },
        {
            "id": "f56b3c9d-0d4e-523e-b89c-4f6e2e0b1d3c",
            "flow": "RECEIVER",
            "recurrenceId": "RR3822895720250530oouu9uhf579",
            "journey": 2,
            "frequencyType": "ANNUAL",
            "authorizationResult": "CANCELLED",
            "beneficiary": {
                "ispb": "38224857",
                "document": "03284584000162",
                "name": "corporateName",
                "agencyNumber": "0001",
                "accountType": "CURRENT",
                "accountNumber": "98765"
            },
            "payer": {
                "ispb": "38224857",
                "type": "LEGAL",
                "document": "03284584000162",
                "name": "corporateName",
                "agencyNumber": "1",
                "accountType": "PAYMENT",
                "accountNumber": "31275",
                "municipalityIbgeCode": 2800308
            },
            "debtor": {
                "type": "NATURAL",
                "document": "86829503086",
                "name": "Conta Teste 02"
            },
            "contractNumber": "1234567890ABC",
            "contractDescription": "Assinatura Anual",
            "recurrenceStartDate": "2025-07-02T00:00:00",
            "recurrenceEndDate": "2026-07-02T00:00:00",
            "recurrenceCreatedAt": "2025-07-04T12:31:54.899Z",
            "requestCreatedAt": "2025-07-04T12:31:55.216Z",
            "requestExpirationAt": "2025-07-04T13:00:00.000Z",
            "recurrenceAuthorizedAt": "2025-07-04T12:31:54.899Z",
            "lastInstructionAt": "2025-07-04T12:31:55.563Z",
            "amount": 100.00,
            "payerMaxAmount": 150.00,
            "minPayerMaxAmount": 100.00,
            "status": "CANCELLED",
            "reasonRejection": null,
            "beneficiaryReconciliationId": "REC-456",
            "cityIbgeCode": "2800308"
        }
    ],
    "pagination": {
        "pageNumber": 1,
        "pageSize": 50,
        "totalPages": 1,
        "totalRecords": 2,
        "hasPreviousPage": false,
        "hasNextPage": false
    }
}